Skip to content

Update results.html - #1069

Merged
maddie-broxup merged 2 commits into
mainfrom
maddie-broxup-patch-4
Jul 8, 2025
Merged

Update results.html#1069
maddie-broxup merged 2 commits into
mainfrom
maddie-broxup-patch-4

Conversation

@maddie-broxup

@maddie-broxup maddie-broxup commented Jul 7, 2025

Copy link
Copy Markdown
Contributor

Content tweaks as per service name from 'submit' to 'provide'

Description

Content wording changes from 'submit' to 'provide' as reflective of new service name

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Related Tickets & Documents

#1013

  • Closes #

QA Instructions, Screenshots, Recordings

Before

Before screenshot here

After

After screenshot here

Added/updated tests?

We encourage you to keep the code coverage percentage at 80% and above.

  • Yes
  • No, and this is why: Please replace this line with details on why tests have not been included
  • I need help with writing tests

QA sign off

  • Code has been checked and approved
  • Design has been checked and approved
  • Product and business logic has been checked and proved

[optional] Are there any post-deployment tasks we need to perform?

[optional] Are there any dependencies on other PRs or Work?

Summary by CodeRabbit

  • Style
    • Updated wording throughout the results page to use "provide" and "providing" instead of "submit" and "submitting" when referring to data checks.

Content tweaks as per service name from 'submit' to 'provide'
@coderabbitai

coderabbitai Bot commented Jul 7, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The update modifies the results HTML template to replace all occurrences of "submit" and "submitting" with "provide" and "providing" regarding data checks. This change affects headings, paragraphs, and button text, but does not alter any logic, control flow, or data structures.

Changes

File(s) Change Summary
src/views/check/results/results.html Updated textual content: replaced "submit"/"submitting" with "provide"/"providing" in all relevant sections. No logic or structural changes.

Possibly related PRs

  • New landing page implementation #1049: Updates configuration and multiple templates, including the landing page and service names, to replace "submit" with "provide," reflecting the same terminology shift in other UI areas.

Poem

A bunny hopped through fields of text,
Swapping "submit" for "provide"—what's next?
With gentle paws and careful care,
The wording's fresh, the meaning fair.
Now data's "provided"—what a ride!
🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions

github-actions Bot commented Jul 7, 2025

Copy link
Copy Markdown

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 66.41% 5956 / 8968
🔵 Statements 66.41% 5956 / 8968
🔵 Functions 64.87% 253 / 390
🔵 Branches 79.7% 758 / 951
File CoverageNo changed files found.
Generated in workflow #1101 for commit 9d76255 by the Vitest Coverage Report Action

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/views/check/results/results.html (1)

155-155: Minor grammar tweak suggested

“…check if it is ready to provide” is a little clunky. Consider “ready to be provided”.

-    <p>Fix the issues, then upload a new version of your data to check if it is ready to provide.</p>
+    <p>Fix the issues, then upload a new version of your data to check if it is ready to be provided.</p>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3fe4172 and b9209d9.

📒 Files selected for processing (1)
  • src/views/check/results/results.html (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: test
  • GitHub Check: run-tests / test
🔇 Additional comments (1)
src/views/check/results/results.html (1)

141-145: Consistent wording change – LGTM

This block mirrors the earlier section and the phrasing reads naturally.

Comment on lines +128 to 131
<h2 class="govuk-heading-m">Issues you must fix before providing your data</h2>

<p>You cannot submit your data to the platform until you fix these issues.</p>
<p>You cannot provide your data to the platform until you fix these issues.</p>

@coderabbitai coderabbitai Bot Jul 7, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Terminology swap looks correct – please sanity-check for any remaining “submit” phrases elsewhere

The updated heading and paragraph consistently use “provide”. Looks good in this block.

Run a quick search to make sure no other templates still tell users to “submit your data”:


🏁 Script executed:

#!/bin/bash
# Search all templates for residual “submit(ting) your data” wording
rg -n -i --context 2 'submit(ting)? your data'

Length of output: 3279


Multiple residual “submit your data” occurrences found – please update to “provide your data” for consistency

A quick grep reveals these remaining instances:

• test/acceptance/request_check.test.js
– Line 111: You cannot submit your data until you fix the issues (update test assertion)

• src/views/submit/check-answers.html
– Line 29: <h1>Check your answers before submitting your dataset</h1>
– Line 140: <h2>Now submit your dataset</h2>

• src/views/organisations/get-started.html
– Line 181: Step title <span class="js-step-title">Submit your data</span>
– Line 188: Link text <a>Submit your data to the Planning Data Platform…</a>

• src/views/check/confirmation.html
– Line 31: ## 2: Submit your data
– Line 33: <a class="submit-link">Submit your data</a> to the Planning Data Platform…

• src/views/check/results/issueDetails.html
– Criteria labels:
• Level 2: You cannot submit your data until you fix the issues
• Level 3: You can submit your data and fix these issues later

Please revise these to use “provide your data” (or “submission” language as appropriate), and update the corresponding test expectations.

🤖 Prompt for AI Agents
In src/views/check/results/results.html around lines 128 to 131, update the
phrase "submit your data" to "provide your data" for consistency. Additionally,
apply this change to all listed files and lines, including
test/acceptance/request_check.test.js line 111,
src/views/submit/check-answers.html lines 29 and 140,
src/views/organisations/get-started.html lines 181 and 188,
src/views/check/confirmation.html lines 31 and 33, and
src/views/check/results/issueDetails.html for the specified criteria labels.
Also, update the corresponding test assertions to reflect this wording change.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In src/views/check/results/results.html around lines 128 to 131, update the
phrase "submit your data" to "provide your data" for consistency. Additionally,
apply this change to all listed files and lines, including
test/acceptance/request_check.test.js line 111,
src/views/submit/check-answers.html lines 29 and 140,
src/views/organisations/get-started.html lines 181 and 188,
src/views/check/confirmation.html lines 31 and 33, and
src/views/check/results/issueDetails.html for the specified criteria labels.
Also, update the corresponding test assertions to reflect this wording change.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧩 Analysis chain

@stevenjmesser I'll help you update the terminology from "submit" to "provide" across all the identified files for consistency. Let me plan these changes:

Task: Update terminology from "submit" to "provide" across multiple files

  • Update src/views/check/results/results.html around lines 128-131
  • Update test/acceptance/request_check.test.js line 111
  • Update src/views/submit/check-answers.html lines 29 and 140
  • Update src/views/organisations/get-started.html lines 181 and 188
  • Update src/views/check/confirmation.html lines 31 and 33
  • Update src/views/check/results/issueDetails.html for criteria labels
  • Ensure test assertions reflect the new wording

Once these changes are implemented, all the terminology will be consistent with "provide" instead of "submit" throughout the application templates and tests.


🏁 Script executed:

#!/bin/bash
# Get the current content of all files that need updating
echo "=== src/views/check/results/results.html around lines 128-131 ==="
sed -n '125,135p' src/views/check/results/results.html

echo -e "\n=== test/acceptance/request_check.test.js line 111 ==="
sed -n '108,114p' test/acceptance/request_check.test.js

echo -e "\n=== src/views/submit/check-answers.html lines 29 and 140 ==="
sed -n '26,32p' src/views/submit/check-answers.html
echo "..."
sed -n '137,143p' src/views/submit/check-answers.html

echo -e "\n=== src/views/organisations/get-started.html lines 181 and 188 ==="
sed -n '178,184p' src/views/organisations/get-started.html
echo "..."
sed -n '185,191p' src/views/organisations/get-started.html

echo -e "\n=== src/views/check/confirmation.html lines 31 and 33 ==="
sed -n '28,36p' src/views/check/confirmation.html

echo -e "\n=== src/views/check/results/issueDetails.html (searching for criteria labels) ==="
rg -n -A 2 -B 2 "cannot submit your data|can submit your data" src/views/check/results/issueDetails.html

Length of output: 3764


Perfect! I can see the current content of all the files. Let me check if there are any remaining "submit" instances in the results.html file that need updating:


🏁 Script executed:

#!/bin/bash
# Check for any remaining "submit" instances in results.html
echo "=== Checking for remaining 'submit' instances in results.html ==="
rg -n -i "submit" src/views/check/results/results.html

echo -e "\n=== Also checking the non-blocking issues section specifically ==="
sed -n '136,145p' src/views/check/results/results.html

Length of output: 751


Great! The results.html file is already fully updated with "provide" terminology. Let me update the plan to focus on the remaining files that still need changes:

Task: Update terminology from "submit" to "provide" across remaining files

  • ✅ src/views/check/results/results.html - Already updated completely
  • Update test/acceptance/request_check.test.js line 111
  • Update src/views/submit/check-answers.html lines 29 and 140
  • Update src/views/organisations/get-started.html lines 181 and 188
  • Update src/views/check/confirmation.html lines 31 and 33
  • Update src/views/check/results/issueDetails.html for criteria labels

The results.html file has already been completely updated with "provide" terminology. These changes will complete the terminology consistency across all the remaining files and their corresponding tests.


⏳ Preparing changes...

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A summary of the changes CodeRabbit can apply:

  • Update multiple files by replacing all instances of "submit your data" with "provide your data" to ensure consistent terminology in user-facing text, including headings, links, criteria labels, and test assertions.

A summary of the context that CodeRabbit is considering across the codebase:

I need to examine the current content of the test file to understand the exact text being tested for assertion updates.

Show context details

Generated Script:

```shell
# Get the current content around line 111 in the test file
sed -n '108,114p' test/acceptance/request_check.test.js

**Shell Result:**

await page.getByText('description column is missing').click()
await page.waitForURL(//check/results/./issue/./, { timeout: 4000 })
await expect(page.getByText('Your data has issues')).toBeVisible()
await expect(page.getByText('You cannot submit your data until you fix the issues')).toBeVisible()
const itemsLocator = page.locator('.govuk-error-summary ul li')
expect(await itemsLocator.count()).toBe(1)
await expect(itemsLocator).toContainText('description column is missing')

</details>

> <rationale>I need to check the current content of the submit check-answers template to see the exact text on lines 29 and 140.</rationale>

<details>
<summary>Show context details</summary>

**Generated Script:**

# Get content around lines 29 and 140 in check-answers.html
sed -n '26,32p' src/views/submit/check-answers.html
echo "..."
sed -n '137,143p' src/views/submit/check-answers.html

**Shell Result:**

{% endif %}

<h1 class="govuk-heading-xl">
  Check your answers before submitting your dataset
</h1>

{{ govukSummaryList({

...
}) }}

<h2 class="govuk-heading-m">
  Now submit your dataset
</h2>

<p class="govuk-body">
</details>

> <rationale>I need to examine the get-started.html file to see the current content on lines 181 and 188.</rationale>

<details>
<summary>Show context details</summary>

**Generated Script:**

# Get content around lines 181 and 188 in get-started.html
sed -n '178,184p' src/views/organisations/get-started.html
echo "..."
sed -n '185,191p' src/views/organisations/get-started.html

**Shell Result:**

          <span class="js-step-title">
            Submit your data
          </span>
        </h2>
      </div>

...

      <div class="gem-c-step-nav__panel js-panel" id="step-panel-submit-your-data-4">
        {% if 'submitEndpointForm' | isFeatureEnabled %}
          <p class="gem-c-step-nav__paragraph"><a href="{{ organisation | endpointSubmissionFormToolDeepLink(dataset) }}">Submit your data</a> to the Planning
            Data Platform. You need to provide your:</p>

          <ul class="govuk-list govuk-list--bullet">
</details>

> <rationale>I need to check the confirmation.html file to see the current content on lines 31 and 33.</rationale>

<details>
<summary>Show context details</summary>

**Generated Script:**

# Get content around lines 31 and 33 in confirmation.html
sed -n '28,36p' src/views/check/confirmation.html

**Shell Result:**

{% if 'submitEndpointForm' | isFeatureEnabled %}

2: Submit your data

Submit your data to the Planning Data Platform. You need to provide your:

  • full name
  • work email address
</details>

> <rationale>I need to check the issueDetails.html file to find the criteria labels that need updating.</rationale>

<details>
<summary>Show context details</summary>

**Generated Script:**

# Search for criteria labels in issueDetails.html
rg -n -A 2 -B 2 "cannot submit your data|can submit your data" src/views/check/results/issueDetails.html

**Shell Result:**

31-


32-
33: {% set criteriaLabels = { '2': 'You cannot submit your data until you fix the issues', '3': 'You can submit your data and fix these issues later' } %}
34- {{ govukErrorSummary({
35- titleText: criteriaLabels[options.task.qualityCriteriaLevel] or 'There is a problem',

</details>

- [ ] <!-- {"checkboxId": "32599f3c-a2a5-4bb9-b887-dee90db62b97", "radioGroupId": "edit-actions-group-2189878674"} --> ✅ Create PR with these edits
- [ ] <!-- {"checkboxId": "85e7c9f1-3a23-4b8e-9f25-d7a5b234a8c1", "radioGroupId": "edit-actions-group-2189878674"} --> 📌 Create commit in current branch
- [ ] <!-- {"checkboxId": "6b3df8e2-79f5-4eb8-9d4a-c7d3a6a5f7b1", "radioGroupId": "edit-actions-group-2189878674"} --> 📋 Get copyable edits

<!-- <agentComponentType>plan-edits</agentComponentType> -->

<!-- <rawResChunk>Looking at the user request, I need to update the terminology from "submit your data" to "provide your data" across multiple files for consistency. I can see that the main `results.html` file has already been updated based on the diff shown. Now I need to update the remaining files identified in the verification agent's analysis.

<context>
<rationale>I need to examine the current content of the test file to understand the exact text being tested for assertion updates.</rationale>
<generated_script>
```shell
# Get the current content around line 111 in the test file
sed -n '108,114p' test/acceptance/request_check.test.js

</generated_script>
<shell_result>
await page.getByText('description column is missing').click()
await page.waitForURL(//check/results/./issue/./, { timeout: 4000 })
await expect(page.getByText('Your data has issues')).toBeVisible()
await expect(page.getByText('You cannot submit your data until you fix the issues')).toBeVisible()
const itemsLocator = page.locator('.govuk-error-summary ul li')
expect(await itemsLocator.count()).toBe(1)
await expect(itemsLocator).toContainText('description column is missing')
</shell_result>

I need to check the current content of the submit check-answers template to see the exact text on lines 29 and 140. ```shell # Get content around lines 29 and 140 in check-answers.html sed -n '26,32p' src/views/submit/check-answers.html echo "..." sed -n '137,143p' src/views/submit/check-answers.html ``` {% endif %}
<h1 class="govuk-heading-xl">
  Check your answers before submitting your dataset
</h1>

{{ govukSummaryList({

...
}) }}

<h2 class="govuk-heading-m">
  Now submit your dataset
</h2>

<p class="govuk-body">

</shell_result>

I need to examine the get-started.html file to see the current content on lines 181 and 188. ```shell # Get content around lines 181 and 188 in get-started.html sed -n '178,184p' src/views/organisations/get-started.html echo "..." sed -n '185,191p' src/views/organisations/get-started.html ```
          <span class="js-step-title">
            Submit your data
          </span>
        </h2>
      </div>

...

      <div class="gem-c-step-nav__panel js-panel" id="step-panel-submit-your-data-4">
        {% if 'submitEndpointForm' | isFeatureEnabled %}
          <p class="gem-c-step-nav__paragraph"><a href="{{ organisation | endpointSubmissionFormToolDeepLink(dataset) }}">Submit your data</a> to the Planning
            Data Platform. You need to provide your:</p>

          <ul class="govuk-list govuk-list--bullet">

</shell_result>

I need to check the confirmation.html file to see the current content on lines 31 and 33. ```shell # Get content around lines 31 and 33 in confirmation.html sed -n '28,36p' src/views/check/confirmation.html ```

{% if 'submitEndpointForm' | isFeatureEnabled %}

2: Submit your data

Submit your data to the Planning Data Platform. You need to provide your:

  • full name
  • work email address
    </shell_result>
I need to check the issueDetails.html file to find the criteria labels that need updating. ```shell # Search for criteria labels in issueDetails.html rg -n -A 2 -B 2 "cannot submit your data|can submit your data" src/views/check/results/issueDetails.html ``` 31-
32- 33: {% set criteriaLabels = { '2': 'You cannot submit your data until you fix the issues', '3': 'You can submit your data and fix these issues later' } %} 34- {{ govukErrorSummary({ 35- titleText: criteriaLabels[options.task.qualityCriteriaLevel] or 'There is a problem', ```shell # Update test file - change "submit" to "provide" in assertion sed -i 's/You cannot submit your data until you fix the issues/You cannot provide your data until you fix the issues/g' test/acceptance/request_check.test.js

Update check-answers.html - change "submitting" to "providing" in heading

sed -i 's/Check your answers before submitting your dataset/Check your answers before providing your dataset/g' src/views/submit/check-answers.html

Update check-answers.html - change "submit" to "provide" in second heading

sed -i 's/Now submit your dataset/Now provide your dataset/g' src/views/submit/check-answers.html

Update get-started.html - change "Submit your data" to "Provide your data" in step title

sed -i 's/Submit your data/Provide your data/g' src/views/organisations/get-started.html

Update confirmation.html - change "Submit your data" to "Provide your data" in heading and link

sed -i 's/## 2: Submit your data/## 2: Provide your data/g' src/views/check/confirmation.html
sed -i 's/>Submit your data to the Planning Data Platform/>Provide your data to the Planning Data Platform/g' src/views/check/confirmation.html

Update issueDetails.html - change criteria labels

sed -i 's/You cannot submit your data until you fix the issues/You cannot provide your data until you fix the issues/g' src/views/check/results/issueDetails.html
sed -i 's/You can submit your data and fix these issues later/You can provide your data and fix these issues later/g' src/views/check/results/issueDetails.html

</changeScript></rawResChunk> -->

<!-- <rawResChunk><planSummary>- Update multiple files by replacing all instances of "submit your data" with "provide your data" to ensure consistent terminology in user-facing text, including headings, links, criteria labels, and test assertions.</planSummary></rawResChunk> -->

<!-- This is an auto-generated reply by CodeRabbit -->

@maddie-broxup
maddie-broxup merged commit f0d7edc into main Jul 8, 2025
5 checks passed
@maddie-broxup
maddie-broxup deleted the maddie-broxup-patch-4 branch July 8, 2025 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants